home *** CD-ROM | disk | FTP | other *** search
/ .net 2002 March / DotNetMagazine-Issue107-Coverdisc-NET107-02-03-PCMac.bin / pc / PC Software / picks / HTTrack / httrack-3.22-3.exe / {app} / src / htsindex.c < prev    next >
Encoding:
C/C++ Source or Header  |  2002-11-17  |  14.5 KB  |  485 lines
  1. /* ------------------------------------------------------------ */
  2. /*
  3. HTTrack Website Copier, Offline Browser for Windows and Unix
  4. Copyright (C) Xavier Roche and other contributors
  5.  
  6. This program is free software; you can redistribute it and/or
  7. modify it under the terms of the GNU General Public License
  8. as published by the Free Software Foundation; either version 2
  9. of the License, or any later version.
  10.  
  11. This program is distributed in the hope that it will be useful,
  12. but WITHOUT ANY WARRANTY; without even the implied warranty of
  13. MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14. GNU General Public License for more details.
  15.  
  16. You should have received a copy of the GNU General Public License
  17. along with this program; if not, write to the Free Software
  18. Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
  19.  
  20.  
  21. Important notes:
  22.  
  23. - We hereby ask people using this source NOT to use it in purpose of grabbing
  24. emails addresses, or collecting any other private information on persons.
  25. This would disgrace our work, and spoil the many hours we spent on it.
  26.  
  27.  
  28. Please visit our Website: http://www.httrack.com
  29. */
  30.  
  31.  
  32. /* ------------------------------------------------------------ */
  33. /* File: htsindex.c                                             */
  34. /*       keyword indexing system (search index)                 */
  35. /* Author: Xavier Roche                                         */
  36. /* ------------------------------------------------------------ */
  37.  
  38.  
  39. #include <stdio.h>
  40. #include <stdlib.h>
  41. #include "htsindex.h"
  42. #include "htsglobal.h"
  43. #include "htslib.h"
  44.  
  45. #if HTS_MAKE_KEYWORD_INDEX
  46. #include "htshash.h"
  47. #include "htsinthash.h"
  48.  
  49.  
  50. /* Keyword Indexer Parameters */
  51.  
  52. // Maximum length for a keyword
  53. #define KEYW_LEN             50
  54. // Minimum length for a keyword - MUST NOT BE NULL!!!
  55. #define KEYW_MIN_LEN         3
  56. // What characters to accept? - MUST NOT BE EMPTY AND MUST NOT CONTAIN THE SPACE (32) CHARACTER!!!
  57. #define KEYW_ACCEPT          "abcdefghijklmnopqrstuvwxyz0123456789-_."
  58. // Convert A to a, and so on.. to avoid case problems in indexing
  59. // This can be a generic table, containing characters that are in fact not accepted by KEYW_ACCEPT
  60. // MUST HAVE SAME SIZES!!
  61. #define KEYW_TRANSCODE_FROM  (\
  62.                                "ABCDEFGHIJKLMNOPQRSTUVWXYZ" \
  63.                                "‡‚‰" \
  64.                                "¿¬ƒ" \
  65.                                "ÈËÍÎ" \
  66.                                "»» À" \
  67.                                "ÏÓÔ" \
  68.                                "ÃŒœ" \
  69.                                "ÚÙˆ" \
  70.                                "“‘÷" \
  71.                                "˘˚¸" \
  72.                                "Ÿ€‹" \
  73.                                "ˇ" \
  74.                              )
  75. #define KEYW_TRANSCODE_TO    ( \
  76.                                "abcdefghijklmnopqrstuvwxyz" \
  77.                                "aaa" \
  78.                                "aaa" \
  79.                                "eeee" \
  80.                                "eeee" \
  81.                                "iii" \
  82.                                "iii" \
  83.                                "ooo" \
  84.                                "ooo" \
  85.                                "uuu" \
  86.                                "uuu" \
  87.                                "y" \
  88.                              )
  89. // These (accepted) characters will be ignored at begining of a keyword
  90. #define KEYW_IGNORE_BEG       "-_."
  91. // These (accepted) characters will be stripped if at the end of a keyword
  92. #define KEYW_STRIP_END       "-_."
  93. // Words begining with these (accepted) characters will be ignored
  94. #define KEYW_NOT_BEG         "0123456789"
  95. // Treat these characters as space characters - MUST NOT BE EMPTY!!!
  96. #define KEYW_SPACE           " ',;:!?\"\x0d\x0a\x09\x0b\x0c"
  97. // Common words (the,for..) detector
  98. // If a word represents more than KEYW_USELESS1K (%1000) of total words, then ignore it
  99. // 5 (0.5%)
  100. #define KEYW_USELESS1K       5
  101. // If a word is present in more than KEYW_USELESS1KPG (%1000) pages, then ignore it
  102. // 800 (80%)
  103. #define KEYW_USELESS1KPG     800
  104. // This number will be reduced by index hit for sorting purpose
  105. // leave it as it is here if you don't REALLY know what you are doing
  106. // Yes, I may be the only person, maybe
  107. #define KEYW_SORT_MAXCOUNT 999999999
  108.  
  109. /* End of Keyword Indexer Parameters */
  110.  
  111. int strcpos(char* adr,char c);
  112. int mystrcmp(const void* _e1,const void* _e2);
  113.  
  114. // Global variables
  115. int hts_index_init=1;
  116. int hts_primindex_size=0;
  117. FILE* fp_tmpproject=NULL;
  118. int hts_primindex_words=0;
  119.  
  120. #endif
  121.  
  122. /* 
  123.   Init index 
  124. */
  125. void index_init(const char* indexpath) {
  126. #if HTS_MAKE_KEYWORD_INDEX
  127.   /* remove(concat(indexpath,"index.txt")); */
  128.   hts_index_init=1;
  129.   hts_primindex_size=0;
  130.   hts_primindex_words=0;
  131.   fp_tmpproject=tmpfile();
  132. #endif
  133. }
  134.  
  135.  
  136. /* 
  137.    Indexing system
  138.    A little bit dirty, (quick'n dirty, in fact)
  139.    But should be okay on most cases
  140.    Tags and javascript handled (ignored)
  141. */
  142. int index_keyword(const char* html_data,LLint size,const char* mime,const char* filename,const char* indexpath) {
  143. #if HTS_MAKE_KEYWORD_INDEX
  144.   int intag=0,inscript=0,incomment=0;
  145.   char keyword[KEYW_LEN+32];
  146.   int i=0;
  147.   //
  148.   int WordIndexSize=1024;
  149.   inthash WordIndexHash=NULL;
  150.   FILE *tmpfp=NULL;
  151.   //
  152.  
  153.   // Check parameters
  154.   if (!html_data)
  155.     return 0;
  156.   if (!size)
  157.     return 0;
  158.   if (!mime)
  159.     return 0;
  160.   if (!filename)
  161.     return 0;
  162.  
  163.   // Init ?
  164.   if (hts_index_init) {
  165.     remove(concat(indexpath,"index.txt"));
  166.     remove(concat(indexpath,"sindex.html"));
  167.     hts_index_init=0;
  168.   }
  169.  
  170.   // Check MIME type
  171.   if (strfield2(mime,"text/html")) {
  172.     inscript=0;
  173.   } 
  174.   // FIXME - temporary fix for image/svg+xml (svg)
  175.   // "IN XML" (html like, in fact :) )
  176.   else if (
  177.     (strfield2(mime,"image/svg+xml"))
  178.     ||
  179.     (strfield2(mime,"image/svg-xml"))
  180.     ) {
  181.     inscript=0;
  182.   }
  183.   else if (
  184.     (strfield2(mime,"application/x-javascript"))
  185.     || (strfield2(mime,"text/css"))
  186.     ) {
  187.     inscript=1;
  188.   } else
  189.     return 0;
  190.  
  191.   // Temporary file
  192.   tmpfp = tmpfile();
  193.   if (!tmpfp)
  194.     return 0;
  195.  
  196.   // Create hash structure
  197.   // Hash tables rulez da world!
  198.   WordIndexHash=inthash_new(WordIndexSize);
  199.   if (!WordIndexHash)
  200.     return 0;
  201.  
  202.   // Start indexing this page
  203.   keyword[0]='\0';
  204.   while(i<size) {
  205.     if (strfield(html_data + i , "<script")) {
  206.       inscript=1;
  207.     } 
  208.     else if (strfield(html_data + i , "<!--")) {
  209.       incomment=1;
  210.     }
  211.     else if (strfield(html_data + i , "</script")) {
  212.       if (!incomment)
  213.         inscript=0;
  214.     } 
  215.     else if (strfield(html_data + i , "-->")) {
  216.       incomment=0;
  217.     }
  218.     else if (html_data[i]=='<') {
  219.       if (!inscript)
  220.         intag=1;
  221.     }    
  222.     else if (html_data[i]=='>') {
  223.       intag=0;
  224.     }    
  225.     else {    
  226.       // Okay, parse keywords
  227.       if ( (!inscript) && (!incomment) && (!intag) ) {
  228.         char cchar=html_data[i];
  229.         int pos;
  230.         int len=strlen(keyword);
  231.         
  232.         // Replace (ignore case, and so on..)
  233.         if ((pos=strcpos(KEYW_TRANSCODE_FROM,cchar))>=0)
  234.           cchar=KEYW_TRANSCODE_TO[pos];
  235.         
  236.         if (strchr(KEYW_ACCEPT,cchar)) {
  237.           /* Ignore some characters at begining */
  238.           if ((len>0) || (!strchr(KEYW_IGNORE_BEG,cchar))) {
  239.             keyword[len++]=cchar;
  240.             keyword[len]='\0';
  241.           }
  242.         } else if ( (strchr(KEYW_SPACE,cchar)) || (!cchar) ) {
  243.  
  244.  
  245.           /* Avoid these words */
  246.           if (len>0) {
  247.             if (strchr(KEYW_NOT_BEG,keyword[0])) {
  248.               keyword[(len=0)]='\0';
  249.             }
  250.           }
  251.  
  252.           /* Strip ending . and so */
  253.           {
  254.             int ok=0;
  255.             while((len=strlen(keyword)) && (!ok)) {
  256.               if (strchr(KEYW_STRIP_END,keyword[len-1])) {      /* strip it */
  257.                 keyword[len-1]='\0';
  258.               } else
  259.                 ok=1;
  260.             }
  261.           }
  262.           
  263.           /* Store it ? */
  264.           if (len >= KEYW_MIN_LEN ) {
  265.             hts_primindex_words++;
  266.             if (inthash_inc(WordIndexHash,keyword)) {   /* added new */
  267.               fprintf(tmpfp,"%s\n",keyword);
  268.             }
  269.           }
  270.           keyword[(len=0)]='\0';
  271.         } else      /* Invalid */
  272.           keyword[(len=0)]='\0';
  273.  
  274.         if (len>KEYW_LEN) {
  275.           keyword[(len=0)]='\0';
  276.         }
  277.       }
  278.       
  279.     }
  280.     
  281.     i++;
  282.   }
  283.  
  284.   // Reset temp file
  285.   fseek(tmpfp,0,SEEK_SET);
  286.  
  287.   // Process indexing for this page
  288.   {
  289.     //FILE* fp=NULL;
  290.     //fp=fopen(concat(indexpath,"index.txt"),"ab");
  291.     if (fp_tmpproject) {
  292.       while(!feof(tmpfp)) {
  293.         char line[KEYW_LEN + 32];
  294.         linput(tmpfp,line,KEYW_LEN + 2);
  295.         if (strnotempty(line)) {
  296.           unsigned long int e=0;
  297.           if (inthash_read(WordIndexHash,line,&e)) {
  298.             //if (e) {
  299.             char savelst[HTS_URLMAXSIZE*2];
  300.             e++;          /* 0 means "once" */
  301.             
  302.             if (strncmp((const char*)fslash((char*)indexpath),filename,strlen(indexpath))==0)  // couper
  303.               strcpybuff(savelst,filename+strlen(indexpath));
  304.             else
  305.               strcpybuff(savelst,filename);
  306.             
  307.             // Add entry for this file and word
  308.             fprintf(fp_tmpproject,"%s %d %s\n",line,(int) (KEYW_SORT_MAXCOUNT - e),savelst);
  309.             hts_primindex_size++;
  310.             //}
  311.           }
  312.         }
  313.       }
  314.       //fclose(fp);
  315.     }
  316.   }
  317.  
  318.   // Delete temp file
  319.   fclose(tmpfp);
  320.   tmpfp=NULL;
  321.  
  322.   // Clear hash table
  323.   inthash_delete(&WordIndexHash);
  324. #endif
  325.   return 1;
  326. }
  327.  
  328. /*
  329.   Sort index!
  330. */
  331. void index_finish(const char* indexpath,int mode) {
  332. #if HTS_MAKE_KEYWORD_INDEX
  333.   char** tab;
  334.   char* blk;
  335.   int size;
  336.   
  337.   size=fpsize(fp_tmpproject);
  338.   if (size>0) {
  339.     //FILE* fp=fopen(concat(indexpath,"index.txt"),"rb");
  340.     if (fp_tmpproject) {
  341.       tab=(char**)malloct(sizeof(char*) * (hts_primindex_size+2) );
  342.       if (tab) {
  343.         blk = malloct(size+4);
  344.         if (blk) {
  345.           fseek(fp_tmpproject,0,SEEK_SET);
  346.           if ((int)fread(blk,1,size,fp_tmpproject) == size) {
  347.             char *a=blk,*b;
  348.             int index=0;
  349.             int i;
  350.             FILE* fp;
  351.  
  352.             while( (b=strchr(a,'\n')) && (index < hts_primindex_size) ) {
  353.               tab[index++]=a;
  354.               *b='\0';
  355.               a=b+1;
  356.             }
  357.             
  358.             // Sort it!
  359.             qsort(tab,index,sizeof(char*),mystrcmp);
  360.  
  361.             // Delete fp_tmpproject
  362.             fclose(fp_tmpproject);
  363.             fp_tmpproject=NULL;
  364.  
  365.             // Write new file
  366.             if (mode == 1)      // TEXT
  367.               fp=fopen(concat(indexpath,"index.txt"),"wb");
  368.             else                // HTML
  369.               fp=fopen(concat(indexpath,"sindex.html"),"wb");
  370.             if (fp) {
  371.               char current_word[KEYW_LEN + 32];
  372.               char word[KEYW_LEN + 32];
  373.               int hit;
  374.               int total_hit=0;
  375.               int total_line=0;
  376.               int last_pos=0;
  377.               char word0='\0';
  378.               current_word[0]='\0';
  379.  
  380.               if (mode == 2) {         // HTML
  381.                 for(i=0;i<index;i++) {
  382.                   if (word0 != tab[i][0]) {
  383.                     word0 = tab[i][0];
  384.                     fprintf(fp," <a href=\"#%c\">%c</a>\r\n",word0,word0);
  385.                   }
  386.                 }
  387.                 word0='\0';
  388.                 fprintf(fp,"<br><br>\r\n");
  389.                 fprintf(fp,"<table width=\"100%%\" border=\"0\">\r\n<tr>\r\n<td>word</td>\r\n<td>location\r\n");
  390.               }
  391.  
  392.               for(i=0;i<index;i++) {
  393.                 if (sscanf(tab[i],"%s %d",word,&hit) == 2) {
  394.                   char*  a=strchr(tab[i],' ');
  395.                   if (a) a=strchr(a+1,' ');
  396.                   if (a++) {                            /* Yes, a++, not ++a :) */
  397.                     hit=KEYW_SORT_MAXCOUNT-hit;
  398.                     if (strcmp(word,current_word)) {    /* New word */
  399.                       if (total_hit) {
  400.                         if (mode == 1)      // TEXT
  401.                           fprintf(fp,"\t=%d\r\n",total_hit);
  402.                         //else                // HTML
  403.                         //  fprintf(fp,"<br>(%d total hits)\r\n",total_hit);
  404.                         if ( 
  405.                               ( ((total_hit*1000 ) / hts_primindex_words) >= KEYW_USELESS1K   )
  406.                             ||
  407.                               ( ((total_line*1000) / index              ) >= KEYW_USELESS1KPG )
  408.                           ) {
  409.                           fseek(fp,last_pos,SEEK_SET);
  410.                           if (mode == 1)      // TEXT
  411.                             fprintf(fp,"\tignored (%d)\r\n",((total_hit*1000)/hts_primindex_words));
  412.                           else
  413.                             fprintf(fp,"(ignored) [%d hits]<br>\r\n",total_hit);
  414.                         }
  415.                         else {
  416.                           if (mode == 1)      // TEXT
  417.                             fprintf(fp,"\t(%d)\r\n",((total_hit*1000)/hts_primindex_words));
  418.                           //else                // HTML
  419.                           //  fprintf(fp,"(%d)\r\n",((total_hit*1000)/hts_primindex_words));
  420.                         }
  421.                       }
  422.                       if (mode == 1)      // TEXT
  423.                         fprintf(fp,"%s\r\n",word);
  424.                       else {              // HTML
  425.                         fprintf(fp,"</td></tr>\r\n");
  426.                         if (word0 != word[0]) {
  427.                           word0 = word[0];
  428.                           fprintf(fp,"<th>%c</th>\r\n",word0);
  429.                           fprintf(fp,"<a name=\"%c\"></a>\r\n",word0);
  430.                         }
  431.                         fprintf(fp,"<tr>\r\n<td>%s</td>\r\n<td>\r\n",word);
  432.                       }
  433.                       fflush(fp); last_pos=ftell(fp);
  434.                       strcpybuff(current_word,word);
  435.                       total_hit=total_line=0;
  436.                     }
  437.                     total_hit+=hit;
  438.                     total_line++;
  439.                     if (mode == 1)      // TEXT
  440.                       fprintf(fp,"\t%d %s\r\n",hit,a);
  441.                     else                // HTML
  442.                       fprintf(fp,"<a href=\"%s\">%s</a> [%d hits]<br>\r\n",a,a,hit);
  443.                   }
  444.                 }
  445.               }
  446.               if (mode == 2)         // HTML
  447.                 fprintf(fp,"</td></tr>\r\n</table>\r\n");
  448.               fclose(fp);
  449.             }
  450.             
  451.           }
  452.           freet(blk);
  453.         }
  454.         freet(tab);
  455.       }
  456.  
  457.     }
  458.     //qsort
  459.   }
  460.   if (fp_tmpproject)
  461.     fclose(fp_tmpproject);
  462.   fp_tmpproject=NULL;
  463. #endif
  464. }
  465.  
  466.  
  467. /* Subroutines */
  468.  
  469. #if HTS_MAKE_KEYWORD_INDEX
  470. int strcpos(char* adr,char c) {
  471.   char* apos=strchr(adr,c);
  472.   if (apos)
  473.     return (int)(apos-adr);
  474.   else
  475.     return -1;
  476. }
  477.  
  478. int mystrcmp(const void* _e1,const void* _e2) {
  479.   char** e1=(char**)_e1;
  480.   char** e2=(char**)_e2;
  481.   return strcmp(*e1,*e2);
  482. }
  483. #endif
  484.  
  485.